Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kie-issues#886: On the DMN Editor, adding waypoints to edges that don't have a corresponding DMNEdge associated with it should create the DMNEdge and add the waypoint normally #2546

Merged
merged 51 commits into from
Oct 1, 2024

Conversation

jomarko
Copy link
Contributor

@jomarko jomarko commented Aug 23, 2024

Closes: apache/incubator-kie-issues#886

Checklist

  • Adding a waypoint on the edge between internal nodes
  • Adding a waypoint on the edge targeting an external node
  • Adding a waypoint on the edge from external node targeting internal node
  • In non default DRD, Adding a waypoint on the edge between internal nodes
  • In non default DRD, Adding a waypoint on the edge targeting an external node
  • In non default DRD, Adding a waypoint on the edge from external node targeting internal node
  • Delete edge between internal nodes and recreate it
  • Delete edge targeting external node - should be recreated automatically
  • Delete edge from external node targeting internal node and recreate it
  • In non default DRD, delete edge between internal nodes and recreate it
  • In non default DRD, delete edge targeting external node - should be recreated automatically
  • In non default DRD, delete edge from external node targeting internal node and recreate it

Current Behavior

In non default DRD, notice the edges waypoints
Screenshot 2024-08-28 154528

…t have a corresponding DMNEdge associated with it should create the DMNEdge and add the waypoint normally.

Closes: apache/incubator-kie-issues#886
@jomarko jomarko added pr: DO NOT MERGE Draft PR, not ready for merging pr: wip PR is still under development area:dmn labels Aug 23, 2024
@@ -195,20 +194,22 @@ export function addEdge({

function doesInformationRequirementsPointTo(a: Normalized<DMN15__tInformationRequirement>, nodeId: string) {
return (
a.requiredInput?.["@_href"] === `${nodeId}` || //
a.requiredDecision?.["@_href"] === `${nodeId}`
// use endsWith because @_href is sometimes prefixed with '#' and sometimes it is not
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is in draft, but let me tell you already that using "endsWith" is not the way to go here. hrefs are structured strings, composed by a namespace and an id. They have this format:

  • #id; or
  • namespace#id; where namespace is an URL.

We have a special parsing method to treat those and separate namespace and id. See parseXmlHref.

@tiagobento
Copy link
Contributor

@jomarko I think this PR is fixing the problem in the wrong place. There's a mutation that adds waypoints... we only need to create an Edge at that moment, if the edge doesn't exist.

@jomarko jomarko removed pr: DO NOT MERGE Draft PR, not ready for merging pr: wip PR is still under development labels Aug 28, 2024
@jomarko jomarko marked this pull request as ready for review August 28, 2024 13:56
@ljmotta
Copy link
Contributor

ljmotta commented Aug 28, 2024

@jomarko @tiagobento The code makes sense to me, but I'm not certain about the solution. I'm just joining the discussion on this issue, so I might have missed something. Why are we adding the edge lazily? Can't we add the DMNEdge to the DRD at the same time we add the Node?

@tiagobento
Copy link
Contributor

@ljmotta We could, but it's more places to handle, as there are multiple places that can add a node to a DRD. If a DMNEdge doesn't exist in the DRD, we render a default edge between the nodes, based on the DRG. Now when we want to add the waypoint, that's when the DMNEdge becomes necessary, otherwise there's no place to add the waypoint to.

@ljmotta
Copy link
Contributor

ljmotta commented Aug 29, 2024

@tiagobento I understand, but we will have an inconsistency between the model and what is visualized in the editor. I mean, the DRD depicts something that isn't on it. Taking a look into another issue, like apache/incubator-kie-issues#1450 we will fall into the same problem, as it wouldn't be possible to tweak the edge properties.

@tiagobento
Copy link
Contributor

Thanks @ljmotta. As we discussed, the DRG should be understood as the primary source of truth, and the DRD should be used to provide a customized depiction of it. DMNEdges, like all DMN DI elements, are optional, so we need to do the best we can to have the DRG correctly depicted even if the DRD doesn't contain visual information about it.

@jomarko jomarko added pr: DO NOT MERGE Draft PR, not ready for merging pr: wip PR is still under development labels Aug 30, 2024
@tiagobento tiagobento changed the title kie-issues#886 On the DMN Editor, adding waypoints to edges that don'… kie-issues#886 On the DMN Editor, adding waypoints to edges that don't have a corresponding DMNEdge associated with it should create the DMNEdge and add the waypoint normally Sep 5, 2024
@tiagobento tiagobento changed the title kie-issues#886 On the DMN Editor, adding waypoints to edges that don't have a corresponding DMNEdge associated with it should create the DMNEdge and add the waypoint normally kie-issues#886: On the DMN Editor, adding waypoints to edges that don't have a corresponding DMNEdge associated with it should create the DMNEdge and add the waypoint normally Sep 5, 2024
@danielzhe
Copy link
Contributor

I didn't find any issues in the manual tests. I tried some not-common scenarios too using external models and it seems everything is working.

Copy link
Contributor

@tiagobento tiagobento left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting there @jomarko. I like the intentionality of the code, especially where you added comments. Left some inline comments, please consider them. Thanks!

Comment on lines 97 to 99
console.debug(
`DMN MUTATION: We can not add DMNEdge for '${edgeId}' edge into diagram. There are missing data edge: ${edge}, edge.data: ${edge?.data}`
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a mutation error. Please adjust the logs.

Comment on lines 106 to 108
console.debug(
`DMN MUTATION: We can not add DMNEdge for '${edgeId}' edge into diagram. There are missing data edgeSourceBounds: ${edgeSourceBounds}, edgeTargetBounds: ${edgeTargetBounds}`
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in a mutation. Please adjust the logs.

Comment on lines 116 to 118
console.debug(
`DMN MUTATION: We can not add DMNEdge for '${edgeId}' edge into diagram. There are missing data sourceNode: ${sourceNode}, targetNode: ${targetNode}`
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in a mutation. Please adjust the logs.

requirementEdgeTargetingExternalNodeId: isTargetExternalNode ? edgeId : undefined,
});

console.debug(`DMN MUTATION: DMNEdge for '${edgeId}' edge was added into diagram.`);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not inside a mutation.

Comment on lines 176 to 180
const dmnEdgeIndex = state.computed(state).indexedDrd().dmnEdgesByDmnElementRef.get(edgeId)?.index;
if (dmnEdgeIndex === undefined) {
console.debug(`DMN MUTATION: DMNEdge for '${edgeId}' edge has missing index.`);
return;
}
Copy link
Contributor

@tiagobento tiagobento Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should throw here, as at this point, this operation should never fail. If edgeIndex doesn't exist, you create a new edge, thus querying for the edgeId again should always give you an edge. If that doesn't happen, something exceptional happened, so we throw. Also not in a mutation.

@@ -96,18 +173,27 @@ export function usePotentialWaypointControls(
}

dmnEditorStoreApi.setState((state) => {
const dmnEdgeIndex = state.computed(state).indexedDrd().dmnEdgesByDmnElementRef.get(edgeId)?.index;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's worth to add a comment here explaining why you're getting dmnEdgeIndex when you already have edgeIndex in scope.

Comment on lines 181 to 187
addEdgeWaypoint({
definitions: state.dmn.model.definitions,
drdIndex,
beforeIndex: i - 1,
edgeIndex,
edgeIndex: dmnEdgeIndex,
waypoint: snappedPotentialWaypoint,
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth changing the name of this parameter to dmnEdgeIndex, since it represents a DMNEdge object.

Comment on lines 39 to 56
export function _checkIsValidConnection(
sourceNode: { type?: string; data: DmnDiagramNodeData } | undefined,
targetNode: { type?: string; data: DmnDiagramNodeData } | undefined,
edgeType: string | null | undefined
edgeType: string | null | undefined,
extraArg?: {
allowExternalTarget: boolean;
}
) {
if (!sourceNode?.type || !targetNode?.type || !edgeType) {
return false;
}

// External nodes cannot be targeted
if (targetNode.data.dmnObjectQName.prefix) {
// External nodes cannot be targeted by default
// However there are exceptions, for example adding a waypoint on the edge
const isTargetExternalNode = targetNode.data.dmnObjectQName.prefix != undefined;
if (!extraArg?.allowExternalTarget && isTargetExternalNode) {
return false;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way, it is clear that false is the default for when extraArg is undefined.

export function _checkIsValidConnection(
  sourceNode: { type?: string; data: DmnDiagramNodeData } | undefined,
  targetNode: { type?: string; data: DmnDiagramNodeData } | undefined,
  edgeType: string | null | undefined,
  extraArg?: { allowExternalTarget: boolean; }
) {
  if (!sourceNode?.type || !targetNode?.type || !edgeType) {
    return false;
  }

  // External nodes cannot be targeted by default. However there are exceptions,
  // for example adding a waypoint on an edge between two external nodes.
  const isTargetExternalNode = targetNode.data.dmnObjectQName.prefix != undefined;
  const allowExternalTarget = extraArg?.allowExternalTarget ?? false;
  if (isTargetExternalNode && !allowExternalTarget) {
    return false;
  }
}

ackEdge({
id: ir["@_id"]!,
id: (namespaceIncludedPrefix ? `${namespaceIncludedPrefix}:` : "") + ir["@_id"]!,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not

Suggested change
id: (namespaceIncludedPrefix ? `${namespaceIncludedPrefix}:` : "") + ir["@_id"]!,
id: (drgElementsNamespace === thisDmnsNamespace
? ir["@_id"]
: buildXmlHref({ namespace: drgElementsNamespace, id: ir["@_id"] }),

?


External nodes are currently using an HREF (namespace#id) as ID, I think we should keep the same strategy for edges, instead of using a QName (prefix:id).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove the definitions parameter you added too, if that ^ makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tiagobento thank you for this topic. actually, nodes/shapes, currently uses prefix:id , not namespace#id, that is why implemented that way for edges.

Applying your suggestion produces xml like attached:

 <dmndi:DMNDI>
    <dmndi:DMNDiagram id="_B90C2A89-A2E3-4610-AC66-A6DC0F9C1CEF" name="Default DRD" useAlternativeInputDataShape="false">
      <di:extension>
        <kie:ComponentsWidthsExtension>
        </kie:ComponentsWidthsExtension>
      </di:extension>
      <dmndi:DMNEdge id="_D763F5B1-FAF0-4790-A905-A5B1D63F0D2C" dmnElementRef="included2:_90FB4683-E1A0-4149-A1B8-444DEE06E749" sourceElement="_A9428417-FA8E-47B7-9F4A-10921FEA34BA" targetElement="_CAFE156E-4FB5-4285-9079-E3165FB92DDE">
        <di:waypoint x="1300" y="260" />
        <di:waypoint x="900" y="240" />
        <di:waypoint x="600" y="400" />
      </dmndi:DMNEdge>
      <dmndi:DMNShape id="_CD133A74-86D5-4DA7-81BF-F122A69A7927" dmnElementRef="included0:_2081EEE3-7B1B-48B3-B3B9-944F0A013CF1">
        <dc:Bounds x="960" y="160" width="160" height="80" />
      </dmndi:DMNShape>
      <dmndi:DMNShape id="_AA2DC9CB-C337-4E8F-8258-ECA14E0CDB10" dmnElementRef="included0:_92040BB1-AB7A-46D1-A4DE-A4FD1448ADF5">
        <dc:Bounds x="700" y="220" width="160" height="80" />
      </dmndi:DMNShape>
      <dmndi:DMNEdge id="_68653841-7F18-46EB-B3F0-37082CC0A3E8" dmnElementRef="https://kie.org/dmn/_AE5E9361-3580-4587-AE13-53A36057853B#_0A18CF15-F3E5-4B87-82A1-2851A246FDF4" sourceElement="_AA2DC9CB-C337-4E8F-8258-ECA14E0CDB10" targetElement="_CD133A74-86D5-4DA7-81BF-F122A69A7927">
        <di:waypoint x="780" y="260" />
        <di:waypoint x="940" y="260" />
        <di:waypoint x="860" y="200" />
        <di:waypoint x="1040" y="200" />
      </dmndi:DMNEdge>
    </dmndi:DMNDiagram>
  </dmndi:DMNDI>

from this discussion my understanding is, I should update the code to use namespace#id also for nodes/shapes? Is that correct?

Copy link
Contributor

@tiagobento tiagobento Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so let's take a step back. This id here is only the ID of the RF.Edge object we're telling ReactFlow exists. How it makes its way to the DMN XML is another story. I believe that ReactFlow objects (nodes and edges) should have their id in the HREF (I.e., namespace#id) format. That's one thing.

Now, you're correct to say that it is wrong to have an HREF in the dmnElementRef attribute, as, per the XSD, it's a QName (I.e., prefix:id). Now, let's try and see how the id of the RF.Edge is getting into the dmnElementRef....

The only place that adds DMNEdges to the XML is the addEdge mutation, so it must be an invocation to it. You added a new invocation to it on this PR... and there's this line:

A. requirementEdgeTargetingExternalNodeId: targetsExternalNode ? edgeId : undefined

See how the edgeId is now inside the addEdge mutation? Now let's look how this new requirementEdgeTargetingExternalNodeId parameter is used inside the addEdge mutation:

B. let existingEdgeId: string | undefined = requirementEdgeTargetingExternalNodeId;; and
C. "@_dmnElementRef": existingEdgeId ?? newEdgeId,

Hmm... something is not right :)


Now, all this is really confusing, because there are multiple ""types"" of id, and there are multiple formats for ids. We have:

  1. The id of the ReactFlow object (I.e., RF.Edge), which I'm saying should be in HREF format.
  2. The id attribute (@_id) of the Information Requirement (which is a plain UUID).
  3. The id attribute (@_id) of the DMNEdge (which is a plain UUID).
  4. The id we need to write to dmnElementRef attribute (@_dmnElementRef), which is in QName format.

They're all "ids" in some way, so it's really hard to name things properly.

Ok, let's go back.


I'd say:

  • A. should be:
    dmnElementRefOfDmnEdge: targetsExternalNode ? informationRequirementQNameRelativeToThisDmn : undefined (this renaming requirementEdgeTargetingExternalNodeId)
  • B. should be:
    let existingRequirementOrAssociationId: string | undefined; (thus renaming existingEdgeId)
  • C. should be:
    "@_dmnElementRef": dmnElementRefOfDmnEdge ?? existingRequirementOrAssociationId ?? newEdgeId

And I believe we should rename newEdgeId to newRequirementOrAssociationId.

Let me know if you have questions :)

Copy link
Contributor

@tiagobento tiagobento Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, we have xmlHrefToQName to help you on building informationRequirementQNameRelativeToThisDmn from edgeId (I.e., Information Requirement's HREF relative to this DMN`).

@jomarko jomarko marked this pull request as draft September 26, 2024 12:17
@jomarko jomarko marked this pull request as ready for review September 27, 2024 08:52
@tiagobento
Copy link
Contributor

@jomarko Conflicts...

@tiagobento tiagobento merged commit 62732c1 into apache:main Oct 1, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants